Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[ECO-4913] Fix fetchRequest implementation does not add 'rnd' query parameter so some HTTP requests get cached in browser #1856

Merged
merged 1 commit into from
Sep 6, 2024
Merged

[ECO-4913] Fix fetchRequest implementation does not add 'rnd' query parameter so some HTTP requests get cached in browser #1856

merged 1 commit into from
Sep 6, 2024

Conversation

VeskeR
Copy link
Contributor

@VeskeR VeskeR commented Sep 6, 2024 •
edited
Loading

Add rnd query param like we do for XHR requests:

ably-js/src/platform/web/lib/http/request/xhrrequest.ts

Line 77 in bd66293

params.rnd = Utils.cheapRandStr();

Resolves #1843

Summary by CodeRabbit

  • New Features
    • Enhanced query parameter construction for fetch requests, improving clarity and maintainability.
    • Added a random string to query parameters to prevent caching and ensure uniqueness in requests.

@VeskeR
Fix fetchRequest implementation does not add 'rnd' query parameter so…
b81d597 
… some HTTP requests get cached in browser

Resolves #1843
@VeskeR VeskeR requested a review from ttypic September 6, 2024 17:37
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Sep 6, 2024 •
edited
Loading

Walkthrough

The changes to the fetchRequest function improve the construction of query parameters for HTTP requests. The implementation now uses URLSearchParams for better organization of parameters and appends a random string to prevent caching. This modification affects the way requests are sent, particularly for the connectivityCheckUrl, ensuring that responses are not served from the browser cache.

Changes

File Path Change Summary
src/platform/web/lib/http/request/fetchrequest.ts Enhanced query parameter construction using URLSearchParams and added a random string for uniqueness.

Assessment against linked issues

Objective Addressed Explanation
FetchRequest doesn't work with checkConnectivity (1843) ✅

🐇 "In the meadow, I hop and play,
New queries dance in a joyful way.
With random strings, we leap and bound,
No more caching, fresh requests abound!
Fetching swiftly, we celebrate,
A brighter path, oh, isn’t it great?" 🐇

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

ttypic
ttypic approved these changes Sep 6, 2024
View reviewed changes
Copy link
Collaborator

@ttypic ttypic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

coderabbitai[bot]
coderabbitai bot reviewed Sep 6, 2024
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)
src/platform/web/lib/http/request/fetchrequest.ts (1)

68-70: Good use of URLSearchParams to handle query parameters.

The implementation effectively addresses the caching issue by appending a random string to the URL parameters. This is a robust solution to ensure that requests are not cached by the browser.

Consider using encodeURIComponent on uri before appending urlParams to ensure that the URI is correctly encoded, especially if uri could contain special characters.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between bd66293 and b81d597.

Files selected for processing (1)
  • src/platform/web/lib/http/request/fetchrequest.ts (1 hunks)
Additional comments not posted (2)
src/platform/web/lib/http/request/fetchrequest.ts (2)

70-71: Proper construction of the final URI and fetch call.

The final URI is constructed correctly by appending the query parameters, and the fetch call is made with the appropriate settings. This ensures that the request is configured correctly and should behave as expected.

Line range hint 1-102: Comprehensive and robust implementation of the fetchRequest function.

The function is well-implemented, covering various aspects of making a fetch request, including error handling, timeouts, and response processing. The changes made in this PR are focused and effectively address the specific issue of caching by adding a random query parameter.

@VeskeR VeskeR merged commit d8d0abf into main Sep 6, 2024
13 checks passed
@VeskeR VeskeR deleted the 1843/fix-fetchrequest-missing-rnd-param branch September 6, 2024 20:07
@coderabbitai coderabbitai bot mentioned this pull request Nov 22, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@ttypic ttypic ttypic approved these changes

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

FetchRequest doesn't work with checkConnectivity
2 participants
@VeskeR @ttypic